Importer/exporter des opérateurs

Deux services Web REST permettent d’importer et d’exporter des données d’opérateur.

Importer des opérateurs

Paramètres d’entrée :

  • Operators.ZIP
  • Nom du site

Le fichier Operators.ZIP peut contenir un ou plusieurs dossiers. Chaque dossier nécessite :

  • Un fichier OperatorId.json
  • Un fichier ZIP de modèles vocaux contenant tous les mots formés de l’opérateur

Lors de l’importation d’un seul opérateur, seul le paramètre operatorId est nécessaire. Aucun paramètre n’est requis lors de l’importation de plusieurs opérateurs.

Les services REST permettent de créer de nouveaux opérateurs ou des opérateurs existants.

Codes de réponse

200 OK : importation réussie de tous les opérateurs

400 Bad Request : contenu du fichier ZIP non valide

207 Multi-Status  : seule une partie des opérateurs ont été importés. Le message d’erreur contient des informations sur tous les opérateurs qui n’ont pas été importés.

Exporter des opérateurs

URL (un seul opérateur) : http://serverip:port/VoiceCheck/services/operator/{operatorId}

où operatorId correspond au nom de connexion de l’opérateur; par exemple, l’opérateur appelétsmith apparaîtrait comme suit :
http://serverip:port/VoiceCheck/services/operator/{tsmith}

URL (tous les opérateurs) : http://serverip:port/VoiceCheck/services/operators/

Pour exporter plusieurs opérateurs à la fois, mais pas tous les opérateurs, appelez n fois le service REST d’exportation d’un seul opérateur.

Méthode : (GET), Content Type (application/json;charset=UTF-8)

Réponse
réussie : état HTTP 200 avec ou sans corps
Échec : le système renvoie une erreur

Résultat : un fichier zip contenant les données des opérateurs.

Contenu et format des fichiers d’importation/d’exportation

Le fichier doit être au format ZIP. Le fichier ZIP contient autant de dossiers qu’il y a d’opérateurs. Par exemple, si cinq opérateurs sont importés ou exportés, le fichier ZIP contiendra cinq dossiers, un par opérateur.

Chaque dossier contient :

  1. Un fichier operator.json : ce fichier contient les détails de l’opérateur, y compris l’ID, le nom et l’adresse courriel de l’opérateur, ainsi qu’un mot de passe chiffré et un code d’accès. Exemple : ben.json
  2. Un fichier ZIP contenant tous les modèles associés à cet opérateur. Le nom du fichier ZIP est «  operatorID_templates.zip  » (exemple : ben_templates.zip)
    • Ce fichier ZIP contient des fichiers .bt2, c’est-à-dire les fichiers des modèles associés à l’opérateur.
    • Le nom du fichier .bt2 apparaît sous le format «  Langue_opérateur_vocab.bt2  » (par exemple : %en-US%_ben_alpha.bt2)